/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007-2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.toolbox_basics_project.spring.manager;

import java.util.Set;

import com.genia.toolbox.security.bean.Permission;
import com.genia.toolbox.basics.exception.technical.TechnicalException;
import com.genia.toolbox.projects.toolbox_basics_project.bean.model.User;

/**
 * manager for {@link Permission}s.
 */
public interface PermissionManager
{

  /**
   * returns the {@link Set} of {@link Permission}s.
   * 
   * @return the {@link Set} of {@link Permission}s
   */
  public Set<Permission> getPermissions();



  /**
   * returns the {@link Set} of {@link Permission}s described by their names.
   * 
   * @param permissions
   *          the names of the {@link Permission}s to retrieve
   * @return the {@link Set} of {@link Permission}s described by their names
   */
  public Set<Permission> getPermissions(Set<String> permissions);



  /**
   * returns the {@link Set} of {@link Permission}s that an user have.
   * 
   * @param user
   *          the {@link User} to retrieve the {@link Permission} for
   * @return the {@link Set} of {@link Permission}s that an user have
   * @throws TechnicalException
   *           if an error occured
   */
  public Set<Permission> getPermissions(User user)
      throws TechnicalException;



  /**
   * returns the {@link Permission}s described by its name.
   * 
   * @param permission
   *          the name of the {@link Permission}
   * @return the {@link Permission}s described by its name
   */
  public Permission getPermission(String permission);
}
